adw.CallbackAnimationTarget source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module adw.CallbackAnimationTarget;
26 
27 private import adw.AnimationTarget;
28 private import adw.c.functions;
29 public  import adw.c.types;
30 private import glib.ConstructionException;
31 private import gobject.ObjectG;
32 
33 
34 /**
35  * An [class@AnimationTarget] that calls a given callback during the
36  * animation.
37  *
38  * Since: 1.0
39  */
40 public class CallbackAnimationTarget : AnimationTarget
41 {
42 	/** the main Gtk struct */
43 	protected AdwCallbackAnimationTarget* adwCallbackAnimationTarget;
44 
45 	/** Get the main Gtk struct */
46 	public AdwCallbackAnimationTarget* getCallbackAnimationTargetStruct(bool transferOwnership = false)
47 	{
48 		if (transferOwnership)
49 			ownedRef = false;
50 		return adwCallbackAnimationTarget;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)adwCallbackAnimationTarget;
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (AdwCallbackAnimationTarget* adwCallbackAnimationTarget, bool ownedRef = false)
63 	{
64 		this.adwCallbackAnimationTarget = adwCallbackAnimationTarget;
65 		super(cast(AdwAnimationTarget*)adwCallbackAnimationTarget, ownedRef);
66 	}
67 
68 
69 	/** */
70 	public static GType getType()
71 	{
72 		return adw_callback_animation_target_get_type();
73 	}
74 
75 	/**
76 	 * Creates a new `AdwAnimationTarget` that calls the given @callback during
77 	 * the animation.
78 	 *
79 	 * Params:
80 	 *     callback = the callback to call
81 	 *     userData = the data to be passed to @callback
82 	 *     destroy = the function to be called when the
83 	 *         callback action is finalized
84 	 *
85 	 * Returns: the newly created callback target
86 	 *
87 	 * Since: 1.0
88 	 *
89 	 * Throws: ConstructionException GTK+ fails to create the object.
90 	 */
91 	public this(AdwAnimationTargetFunc callback, void* userData, GDestroyNotify destroy)
92 	{
93 		auto __p = adw_callback_animation_target_new(callback, userData, destroy);
94 
95 		if(__p is null)
96 		{
97 			throw new ConstructionException("null returned by new");
98 		}
99 
100 		this(cast(AdwCallbackAnimationTarget*) __p, true);
101 	}
102 }